[]
        
在线Demo 免费试用
(Showing Draft Content)

DashboardFilterView

DashboardFilterView

[POST] /api/v2/dashboard/filter-views

创建文档变体。

请求数据格式

DashboardFilterViewRequest

返回值

状态码: 200

成功

DashboardFilterViewResponse

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/dashboard/filter-views

返回不带参数和自定义属性的文档变体列表。

参数:

名称 类型 位置 描述
refDocumentId string query 变体引用的文档标识符

返回值

状态码: 200

成功

DocumentFilterViewModelBase

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[GET] /api/v2/dashboard/filter-views/{id}

返回文档变体。

参数:

名称 类型 位置 描述
id必填项 string path

返回值

状态码: 200

成功

DocumentFilterViewModel

状态码: 400

错误的请求

ServerPluginError

状态码: 404

未找到

ServerPluginError

[POST] /api/v2/dashboard/filter-views/batch-delete

删除文档变体。

请求数据格式

DocumentFilterViewDeleteRequest

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

[PUT] /api/v2/dashboard/filter-views/batch-rename

重命名文档变体。

请求数据格式

DocumentFilterViewRenameRequestItem

返回值

状态码: 204

无内容

状态码: 400

错误的请求

ServerPluginError

类型定义

Ƭ DashboardFilterViewResponse

仪表板过滤器视图 POST 响应

名称 类型 描述 示例
id可为空 string 新的仪表板过滤器视图 ID

Ƭ ServerPluginError

服务器插件错误

名称 类型 描述 示例
code可为空 string 错误代码
message可为空 string 错误信息
context可为空 string 错误上下文

Ƭ DashboardFilterViewRequest

仪表板过滤器视图 POST 请求

名称 类型 描述 示例
name string 新过滤视图名称
refDocumentId string 参考仪表板 ID
content string 过滤视图内容

Ƭ DocumentFilterViewModelBase

仪表板过滤器视图列表 GET 响应

名称 类型 描述 示例
id可为空 string 仪表板筛选器视图 ID
name可为空 string 仪表板过滤器视图名称
effectiveOps可为空 string 仪表板过滤器视图有效操作
refDocumentId可为空 string 仪表板参考文档 ID

Ƭ DocumentFilterViewModel

仪表板过滤器视图 GET 响应

名称 类型 描述 示例
security可为空 string 仪表板过滤器视图安全性
content可为空 string 仪表板过滤器查看内容
id可为空 string 仪表板筛选器视图 ID
name可为空 string 仪表板过滤器视图名称
effectiveOps可为空 string 仪表板过滤器视图有效操作
refDocumentId可为空 string 仪表板参考文档 ID

Ƭ DocumentFilterViewDeleteRequest

仪表板过滤器视图删除请求

名称 类型 描述 示例
ids Array<string> 仪表板过滤器视图 ID

Ƭ DocumentFilterViewRenameRequestItem

仪表板过滤器视图重命名请求项目

名称 类型 描述 示例
id string 仪表板筛选器视图 ID
name string 仪表板过滤器视图名称